<!doctype html>
<html lang="en">
        <head>
                <meta charset="utf-8">
                <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
                <meta name="generator" content="pdoc 0.9.1" />
                <title>sudoku_start API documentation</title>
                <meta name="description" content="This module is a sudoku generator that will load a `.sudoku` file with sudoku boards. And runs `MainWindow` from tk_sudoku_game …" />
                <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
                <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
                <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
                <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
                <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
                <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
                <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
                <script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
                <link rel="stylesheet" type="text/css" href="github-style.css">
        </head>
        <body>
                <main>
                        <article id="content">
                                <header>
                                        <h1 class="title">Module <code>sudoku_start</code></h1>
                                </header>
                                <section id="section-intro">
                                        <p>This module is a sudoku generator that will load a <code>.sudoku</code> file with sudoku boards. And runs <code>MainWindow</code> from tk_sudoku_game.</p>
                                        <p><strong>External modules</strong>: <code>random</code>, <code>os</code>, <code>argparse</code></p>
                                        <p><code>Compatible with Python3.7 or higher</code></p>
                                        <p><em>Repository:</em> <a href="https://github.com/rickfernandes/sudoku_solver">https://github.com/rickfernandes/sudoku_solver</a></p>
                                        <details class="source">
                                        <summary>
                                        <span>Expand source code</span>
                                        </summary>
                                        <pre><code class="python"># -*- coding: utf-8 -*-
                                                &#34;&#34;&#34;
                                                This module is a sudoku generator that will load a `.sudoku` file with sudoku boards. And runs `MainWindow` from tk_sudoku_game.
                                                __External modules__: `random`, `os`, `argparse`
                                                `Compatible with Python3.7 or higher`\n
                                                _Repository:_ https://github.com/rickfernandes/sudoku_solver
                                                &#34;&#34;&#34;
                                                from tk_sudoku_game import MainWindow
                                                from os import listdir
                                                from random import randint
                                                from argparse import ArgumentParser
                                                FOLDER = &#39;boards/&#39;
                                                &#34;&#34;&#34;Folder containing the sudoku boards as `.sudoku` files.&#34;&#34;&#34;
                                                def ParseArguments():
                                                        &#34;&#34;&#34;Function to parse the arguments passed by the user. Argument `--board` is not required and, if not passed, uses `random` as default.
                                                        Args:
                                                                __None__
                                                        Dependencies:
                                                                `ArgumentParser()` (function): from `argparse` module.
                                                        Returns:
                                                                `board_name` (str): returns a string that represents the board (i.e. file) name.
                                                    &#34;&#34;&#34;
                                                        arg_parser = ArgumentParser()
                                                        arg_parser.add_argument(&#34;--board&#34;,
                                                                                                        help=&#34;Board name or random&#34;,
                                                                                                        type=str,
                                                                                                        default=&#39;random&#39;,
                                                                                                        required=False)
                                                        args = vars(arg_parser.parse_args())
                                                        return args[&#39;board&#39;]
                                                def ConvertBoard(board_name):
                                                        &#34;&#34;&#34;Function to convert the `board_name` file to a matrix.
                                                        Args:
                                                                `board_name` (str): the value must be `random` or a filename present in `FOLDER` directory.
                                                        Dependencies:
                                                                `ArgumentParser()` (function): from `argparse` module.
                                                        Returns:
                                                                `board_name` (str): returns a string that represents the board (i.e. file) name.
                                                    &#34;&#34;&#34;
                                                        board = []
                                                        with open(f&#39;{FOLDER}{board_name}.sudoku&#39;, &#39;r&#39;) as board_file:
                                                                flat_board = board_file.read()
                                                                &#34;&#34;&#34;Opens and reads the board file.&#34;&#34;&#34;
                                                        for i in range(0,90,10):
                                                                &#34;&#34;&#34;Loops through all numbers in `flat_board` converting them into a matrix.&#34;&#34;&#34;
                                                                row = []
                                                                for j in range(9):
                                                                        row.append(int(flat_board[i+j]))
                                                                board.append(row)
                                                        return board
                                                def GetBoards():
                                                        &#34;&#34;&#34;Function to get list of boards (i.e. files) in `FOLDER`.
                                                        Args:
                                                                __None__
                                                        Dependencies:
                                                                __None__
                                                        Returns:
                                                                `boards` (array): array with all files in `FOLDER`.
                                                        &#34;&#34;&#34;
                                                        boards = listdir(f&#39;./{FOLDER}&#39;)
                                                        for board in boards:
                                                                if &#39;.sudoku&#39; not in board:
                                                                        &#34;&#34;&#34;Loops through the files in `FOLDER` and removes if it&#39;s not .sudoku&#34;&#34;&#34;
                                                                        boards.remove(board)
                                                        try: boards.remove(&#39;debug.sudoku&#39;)
                                                        except: pass
                                                        &#34;&#34;&#34;Tries to remove `debug` board&#34;&#34;&#34;
                                                        return boards
                                                def GetBoard():
                                                        &#34;&#34;&#34;Function to get a board from the boards (i.e. files) in `FOLDER`.
                                                        Args:
                                                                __None__
                                                        Dependencies:
                                                                __None__
                                                        Returns:
                                                                `board_name` (str): string with the filename.
                                                        &#34;&#34;&#34;
                                                        board_name, boards = ParseArguments(), GetBoards()
                                                        
                                                        if board_name == &#39;random&#39;:
                                                                board_name = boards[randint(0,len(boards)-1)]
                                                        elif board_name not in boards:
                                                                print(&#39;invalid board, random used&#39;)
                                                                board_name = boards[randint(0,len(boards)-1)]
                                                        else:
                                                                pass
                                                        board_name = board_name.replace(&#39;.sudoku&#39;,&#39;&#39;)
                                                        print(f&#39;{board_name} board used&#39;)
                                                        return board_name
                                                if __name__ == &#39;__main__&#39;:
                                                        board = ConvertBoard(GetBoard())
                                        MainWindow(board).mainloop()</code></pre>
                                        </details>
                                </section>
                                <section>
                                </section>
                                <section>
                                        <h2 class="section-title" id="header-variables">Global variables</h2>
                                        <dl>
                                                <dt id="sudoku_start.FOLDER"><code class="name">var <span class="ident">FOLDER</span></code></dt>
                                                <dd>
                                                <div class="desc"><p>Folder containing the sudoku boards as <code>.sudoku</code> files.</p></div>
                                                </dd>
                                        </dl>
                                </section>
                                <section>
                                        <h2 class="section-title" id="header-functions">Functions</h2>
                                        <dl>
                                                <dt id="sudoku_start.ConvertBoard"><code class="name flex">
                                                <span>def <span class="ident">ConvertBoard</span></span>(<span>board_name)</span>
                                                </code></dt>
                                                <dd>
                                                <div class="desc"><p>Function to convert the <code>board_name</code> file to a matrix.</p>
                                                <h2 id="args">Args</h2>
                                                <p><code>board_name</code> (str): the value must be <code>random</code> or a filename present in <code><a title="sudoku_start.FOLDER" href="#sudoku_start.FOLDER">FOLDER</a></code> directory.</p>
                                                <h2 id="dependencies">Dependencies</h2>
                                                <p><code>ArgumentParser()</code> (function): from <code>argparse</code> module.</p>
                                                <h2 id="returns">Returns</h2>
                                                <p><code>board_name</code> (str): returns a string that represents the board (i.e. file) name.</p></div>
                                                <details class="source">
                                                <summary>
                                                <span>Expand source code</span>
                                                </summary>
                                                <pre><code class="python">def ConvertBoard(board_name):
                                                                &#34;&#34;&#34;Function to convert the `board_name` file to a matrix.
                                                                Args:
                                                                        `board_name` (str): the value must be `random` or a filename present in `FOLDER` directory.
                                                                Dependencies:
                                                                        `ArgumentParser()` (function): from `argparse` module.
                                                                Returns:
                                                                        `board_name` (str): returns a string that represents the board (i.e. file) name.
                                                            &#34;&#34;&#34;
                                                                board = []
                                                                with open(f&#39;{FOLDER}{board_name}.sudoku&#39;, &#39;r&#39;) as board_file:
                                                                        flat_board = board_file.read()
                                                                        &#34;&#34;&#34;Opens and reads the board file.&#34;&#34;&#34;
                                                                for i in range(0,90,10):
                                                                        &#34;&#34;&#34;Loops through all numbers in `flat_board` converting them into a matrix.&#34;&#34;&#34;
                                                                        row = []
                                                                        for j in range(9):
                                                                                row.append(int(flat_board[i+j]))
                                                                        board.append(row)
                                                return board</code></pre>
                                                </details>
                                                </dd>
                                                <dt id="sudoku_start.GetBoard"><code class="name flex">
                                                <span>def <span class="ident">GetBoard</span></span>(<span>)</span>
                                                </code></dt>
                                                <dd>
                                                <div class="desc"><p>Function to get a board from the boards (i.e. files) in <code><a title="sudoku_start.FOLDER" href="#sudoku_start.FOLDER">FOLDER</a></code>.</p>
                                                <h2 id="args">Args</h2>
                                                <p><strong>None</strong></p>
                                                <h2 id="dependencies">Dependencies</h2>
                                                <p><strong>None</strong></p>
                                                <h2 id="returns">Returns</h2>
                                                <p><code>board_name</code> (str): string with the filename.</p></div>
                                                <details class="source">
                                                <summary>
                                                <span>Expand source code</span>
                                                </summary>
                                                <pre><code class="python">def GetBoard():
                                                                &#34;&#34;&#34;Function to get a board from the boards (i.e. files) in `FOLDER`.
                                                                Args:
                                                                        __None__
                                                                Dependencies:
                                                                        __None__
                                                                Returns:
                                                                        `board_name` (str): string with the filename.
                                                                &#34;&#34;&#34;
                                                                board_name, boards = ParseArguments(), GetBoards()
                                                                
                                                                if board_name == &#39;random&#39;:
                                                                        board_name = boards[randint(0,len(boards)-1)]
                                                                elif board_name not in boards:
                                                                        print(&#39;invalid board, random used&#39;)
                                                                        board_name = boards[randint(0,len(boards)-1)]
                                                                else:
                                                                        pass
                                                                board_name = board_name.replace(&#39;.sudoku&#39;,&#39;&#39;)
                                                                print(f&#39;{board_name} board used&#39;)
                                                return board_name</code></pre>
                                                </details>
                                                </dd>
                                                <dt id="sudoku_start.GetBoards"><code class="name flex">
                                                <span>def <span class="ident">GetBoards</span></span>(<span>)</span>
                                                </code></dt>
                                                <dd>
                                                <div class="desc"><p>Function to get list of boards (i.e. files) in <code><a title="sudoku_start.FOLDER" href="#sudoku_start.FOLDER">FOLDER</a></code>.</p>
                                                <h2 id="args">Args</h2>
                                                <p><strong>None</strong></p>
                                                <h2 id="dependencies">Dependencies</h2>
                                                <p><strong>None</strong></p>
                                                <h2 id="returns">Returns</h2>
                                                <p><code>boards</code> (array): array with all files in <code><a title="sudoku_start.FOLDER" href="#sudoku_start.FOLDER">FOLDER</a></code>.</p></div>
                                                <details class="source">
                                                <summary>
                                                <span>Expand source code</span>
                                                </summary>
                                                <pre><code class="python">def GetBoards():
                                                                &#34;&#34;&#34;Function to get list of boards (i.e. files) in `FOLDER`.
                                                                Args:
                                                                        __None__
                                                                Dependencies:
                                                                        __None__
                                                                Returns:
                                                                        `boards` (array): array with all files in `FOLDER`.
                                                                &#34;&#34;&#34;
                                                                boards = listdir(f&#39;./{FOLDER}&#39;)
                                                                for board in boards:
                                                                        if &#39;.sudoku&#39; not in board:
                                                                                &#34;&#34;&#34;Loops through the files in `FOLDER` and removes if it&#39;s not .sudoku&#34;&#34;&#34;
                                                                                boards.remove(board)
                                                                try: boards.remove(&#39;debug.sudoku&#39;)
                                                                except: pass
                                                                &#34;&#34;&#34;Tries to remove `debug` board&#34;&#34;&#34;
                                                return boards</code></pre>
                                                </details>
                                                </dd>
                                                <dt id="sudoku_start.ParseArguments"><code class="name flex">
                                                <span>def <span class="ident">ParseArguments</span></span>(<span>)</span>
                                                </code></dt>
                                                <dd>
                                                <div class="desc"><p>Function to parse the arguments passed by the user. Argument <code>--board</code> is not required and, if not passed, uses <code>random</code> as default.</p>
                                                <h2 id="args">Args</h2>
                                                <p><strong>None</strong></p>
                                                <h2 id="dependencies">Dependencies</h2>
                                                <p><code>ArgumentParser()</code> (function): from <code>argparse</code> module.</p>
                                                <h2 id="returns">Returns</h2>
                                                <p><code>board_name</code> (str): returns a string that represents the board (i.e. file) name.</p></div>
                                                <details class="source">
                                                <summary>
                                                <span>Expand source code</span>
                                                </summary>
                                                <pre><code class="python">def ParseArguments():
                                                                &#34;&#34;&#34;Function to parse the arguments passed by the user. Argument `--board` is not required and, if not passed, uses `random` as default.
                                                                Args:
                                                                        __None__
                                                                Dependencies:
                                                                        `ArgumentParser()` (function): from `argparse` module.
                                                                Returns:
                                                                        `board_name` (str): returns a string that represents the board (i.e. file) name.
                                                            &#34;&#34;&#34;
                                                                arg_parser = ArgumentParser()
                                                                arg_parser.add_argument(&#34;--board&#34;,
                                                                                                                help=&#34;Board name or random&#34;,
                                                                                                                type=str,
                                                                                                                default=&#39;random&#39;,
                                                                                                                required=False)
                                                                args = vars(arg_parser.parse_args())
                                                return args[&#39;board&#39;]</code></pre>
                                                </details>
                                                </dd>
                                        </dl>
                                </section>
                                <section>
                                </section>
                        </article>
                        <nav id="sidebar">
                                <h1>Index</h1>
                                <div class="toc">
                                <ul></ul>
                        </div>
                        <ul id="index">
                                <li><h3><a href="#header-variables">Global variables</a></h3>
                                <ul class="">
                                        <li><code><a title="sudoku_start.FOLDER" href="#sudoku_start.FOLDER">FOLDER</a></code></li>
                                </ul>
                        </li>
                        <li><h3><a href="#header-functions">Functions</a></h3>
                        <ul class="">
                                <li><code><a title="sudoku_start.ConvertBoard" href="#sudoku_start.ConvertBoard">ConvertBoard</a></code></li>
                                <li><code><a title="sudoku_start.GetBoard" href="#sudoku_start.GetBoard">GetBoard</a></code></li>
                                <li><code><a title="sudoku_start.GetBoards" href="#sudoku_start.GetBoards">GetBoards</a></code></li>
                                <li><code><a title="sudoku_start.ParseArguments" href="#sudoku_start.ParseArguments">ParseArguments</a></code></li>
                        </ul>
                </li>
        </ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
</footer>
</body>
</html>